home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Reference Guide / C-C++ Interactive Reference Guide.iso / c_ref / csource3 / 144_01 / clean.hlp < prev    next >
Text File  |  1985-08-21  |  2KB  |  52 lines
  1. **********************************************************************
  2. *                              CLEAN                                 *
  3. **********************************************************************
  4. *                  COPYRIGHT 1983 EUGENE H. MALLORY                  *
  5. **********************************************************************
  6. PROGRAM:
  7.      CLEAN  - Cleans up a text file, can indicate bad characters.
  8. USAGE:
  9.      CLEAN  [<fid] [-I] [-H] [>fid]
  10. FUNCTION:
  11.     
  12.     This cleans up a number of problems with text files. It can 
  13.     operate in two modes.  In the default mode, control characters 
  14.     are stripped out, characters with high order bits on are 
  15.     stripped, tabs are expanded, lines too long are split, naked CR's 
  16.     are converted to CR NL pairs and files without ending CR NL get 
  17.     them.  Both kinds of CP/M end-of-files are handled and a true EOF 
  18.     character put at the end. Also, trailing blanks are stripped from
  19.     lines.
  20.     
  21.     IF the -I option is used, control characters, including tab, will 
  22.     be indicated by a ^ preceding the character plus hex 040.  Thus, 
  23.     a tab will become ^I.  Characters with the high order bit on will 
  24.     be preceded by a ~.  The character is stripped of its high order 
  25.     bit and the processed as normally.  Thus, a tab with the top bit 
  26.     set would come out as a ~^I.  In order to show the true ~ and ^, 
  27.     they are doubled so that a ^ is shown as a ^^.
  28.     
  29.     The -H option lists the available options.
  30.  
  31.     EXAMPLE:
  32.      CLEAN  <DIRTY >CLEAN    {Cleans up a dirty file.}
  33.      CLEAN <DIRTY -I        {Shows the dirty characters in a file.}
  34.     
  35.  
  36.  
  37.         Command Line                       
  38.  
  39. ___________________________________  
  40.                                   |  
  41.                                   |  
  42.                                   |  -I OPTION
  43.                                   |  
  44.                                   |                  
  45.                     ______________V______________    
  46.  Standard Input     |                           |   Standard Output
  47.      TEXT           |                           |      CLEAN TEXT
  48. ------------------->|           CLEAN           |----------------------->
  49.                     |                           |
  50.                     |                           |
  51.                     |___________________________|
  52.